<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>FieldAdapter xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/azeckoski/reflectutils/beanutils/FieldAdapter.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: FieldAdapter.html 10 2008-10-01 10:56:15Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://reflectutils.googlecode.com/svn/maven/site/xref/org/azeckoski/reflectutils/beanutils/FieldAdapter.html $</em>
<a name="4" href="#4">4</a>   <em> * FieldAdapter.java - genericdao - Sep 20, 2008 8:15:36 AM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2.0</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski @ gmail.com) (aaronz @ vt.edu) (aaron @ caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.azeckoski.reflectutils.beanutils;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.util.List;
<a name="18" href="#18">18</a>  <strong>import</strong> java.util.Map;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <strong>import</strong> org.azeckoski.reflectutils.ClassFields.FieldsFilter;
<a name="21" href="#21">21</a>  <strong>import</strong> org.azeckoski.reflectutils.exceptions.FieldGetValueException;
<a name="22" href="#22">22</a>  <strong>import</strong> org.azeckoski.reflectutils.exceptions.FieldSetValueException;
<a name="23" href="#23">23</a>  <strong>import</strong> org.azeckoski.reflectutils.exceptions.FieldnameNotFoundException;
<a name="24" href="#24">24</a>  
<a name="25" href="#25">25</a>  
<a name="26" href="#26">26</a>  <em>/**<em>*</em></em>
<a name="27" href="#27">27</a>  <em> * Interface that allows us to adapt to special class types like the apache dynabeans without</em>
<a name="28" href="#28">28</a>  <em> * requiring them to be a dependency unless they happen to be in the ClassLoader</em>
<a name="29" href="#29">29</a>  <em> * </em>
<a name="30" href="#30">30</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="31" href="#31">31</a>  <em> */</em>
<a name="32" href="#32">32</a>  <strong>public</strong> <strong>interface</strong> <a href="../../../../org/azeckoski/reflectutils/beanutils/FieldAdapter.html">FieldAdapter</a> {
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>      <em>/**<em>*</em></em>
<a name="35" href="#35">35</a>  <em>     * @param obj any object</em>
<a name="36" href="#36">36</a>  <em>     * @return true if this object is part of the set this adapter is made to handle, false otherwise</em>
<a name="37" href="#37">37</a>  <em>     */</em>
<a name="38" href="#38">38</a>      <strong>public</strong> <strong>boolean</strong> isAdaptableObject(Object obj);
<a name="39" href="#39">39</a>  
<a name="40" href="#40">40</a>      <em>/**<em>*</em></em>
<a name="41" href="#41">41</a>  <em>     * @param beanClass any class</em>
<a name="42" href="#42">42</a>  <em>     * @return true if this class is adaptable, false otherwise</em>
<a name="43" href="#43">43</a>  <em>     */</em>
<a name="44" href="#44">44</a>      <strong>public</strong> <strong>boolean</strong> isAdaptableClass(Class&lt;?> beanClass);
<a name="45" href="#45">45</a>  
<a name="46" href="#46">46</a>      <em>/**<em>*</em></em>
<a name="47" href="#47">47</a>  <em>     * @return a new instance of the adapted class type based on a sample</em>
<a name="48" href="#48">48</a>  <em>     */</em>
<a name="49" href="#49">49</a>      <strong>public</strong> Object newInstance(Object bean);
<a name="50" href="#50">50</a>  
<a name="51" href="#51">51</a>      <em>/**<em>*</em></em>
<a name="52" href="#52">52</a>  <em>     * @param bean any bean of the adaptable class type</em>
<a name="53" href="#53">53</a>  <em>     * @return the list of property names for that bean</em>
<a name="54" href="#54">54</a>  <em>     */</em>
<a name="55" href="#55">55</a>      <strong>public</strong> List&lt;String> getPropertyNames(Object bean);
<a name="56" href="#56">56</a>  
<a name="57" href="#57">57</a>      <em>/**<em>*</em></em>
<a name="58" href="#58">58</a>  <em>     * Finds the type for a field based on the containing object and the field name</em>
<a name="59" href="#59">59</a>  <em>     * @param obj any object</em>
<a name="60" href="#60">60</a>  <em>     * @param name the name of a field in this object (can be nested, indexed, mapped, etc.)</em>
<a name="61" href="#61">61</a>  <em>     * @return the type of the field (will be {@link Object} if the type is indeterminate)</em>
<a name="62" href="#62">62</a>  <em>     * @throws FieldnameNotFoundException if the name is invalid for this obj</em>
<a name="63" href="#63">63</a>  <em>     * @throws IllegalArgumentException if the params are null</em>
<a name="64" href="#64">64</a>  <em>     */</em>
<a name="65" href="#65">65</a>      <strong>public</strong> Class&lt;?> getFieldType(Object obj, String name);
<a name="66" href="#66">66</a>  
<a name="67" href="#67">67</a>      <em>/**<em>*</em></em>
<a name="68" href="#68">68</a>  <em>     * Get the values of all fields on an object but optionally filter the fields used</em>
<a name="69" href="#69">69</a>  <em>     * @param obj any object</em>
<a name="70" href="#70">70</a>  <em>     * @param filter (optional) indicates the fields to return the values for, can be null for defaults &lt;br/></em>
<a name="71" href="#71">71</a>  <em>     * WARNING: getting the field values from settable only fields works as expected (i.e. you will an empty map)</em>
<a name="72" href="#72">72</a>  <em>     * @return a map of field name -> value</em>
<a name="73" href="#73">73</a>  <em>     * @throws IllegalArgumentException if the obj is null</em>
<a name="74" href="#74">74</a>  <em>     */</em>
<a name="75" href="#75">75</a>      <strong>public</strong> Map&lt;String, Object> getFieldValues(Object obj, FieldsFilter filter);
<a name="76" href="#76">76</a>  
<a name="77" href="#77">77</a>      <em>/**<em>*</em></em>
<a name="78" href="#78">78</a>  <em>     * For getting a value out of a bean based on a field name,</em>
<a name="79" href="#79">79</a>  <em>     * mostly for internal usage, use getFieldValue</em>
<a name="80" href="#80">80</a>  <em>     * &lt;br/></em>
<a name="81" href="#81">81</a>  <em>     * &lt;b>WARNING: Cannot handle a nested/mapped/indexed name&lt;/b></em>
<a name="82" href="#82">82</a>  <em>     * </em>
<a name="83" href="#83">83</a>  <em>     * @throws FieldnameNotFoundException if this field name is invalid for this object</em>
<a name="84" href="#84">84</a>  <em>     * @throws IllegalArgumentException if there is failure</em>
<a name="85" href="#85">85</a>  <em>     */</em>
<a name="86" href="#86">86</a>      <strong>public</strong> Object getSimpleValue(Object obj, String name);
<a name="87" href="#87">87</a>  
<a name="88" href="#88">88</a>      <em>/**<em>*</em></em>
<a name="89" href="#89">89</a>  <em>     * For getting an indexed value out of an object based on field name,</em>
<a name="90" href="#90">90</a>  <em>     * mostly for internal usage, use getFieldValue</em>
<a name="91" href="#91">91</a>  <em>     * &lt;br/></em>
<a name="92" href="#92">92</a>  <em>     * &lt;b>WARNING: Cannot handle a nested/mapped/indexed name&lt;/b></em>
<a name="93" href="#93">93</a>  <em>     * </em>
<a name="94" href="#94">94</a>  <em>     * @throws FieldnameNotFoundException if this field name is invalid for this object</em>
<a name="95" href="#95">95</a>  <em>     * @throws IllegalArgumentException if there is a failure</em>
<a name="96" href="#96">96</a>  <em>     * @throws FieldGetValueException if there is an internal failure getting the field</em>
<a name="97" href="#97">97</a>  <em>     */</em>
<a name="98" href="#98">98</a>      <strong>public</strong> Object getIndexedValue(Object obj, String name, <strong>int</strong> index);
<a name="99" href="#99">99</a>  
<a name="100" href="#100">100</a>     <em>/**<em>*</em></em>
<a name="101" href="#101">101</a> <em>     * For getting a mapped value out of an object based on field name,</em>
<a name="102" href="#102">102</a> <em>     * mostly for internal usage, use getFieldValue</em>
<a name="103" href="#103">103</a> <em>     * &lt;br/></em>
<a name="104" href="#104">104</a> <em>     * &lt;b>WARNING: Cannot handle a nested/mapped/indexed name&lt;/b></em>
<a name="105" href="#105">105</a> <em>     * @throws FieldnameNotFoundException if this field name is invalid for this object</em>
<a name="106" href="#106">106</a> <em>     * @throws IllegalArgumentException if there are invalid arguments</em>
<a name="107" href="#107">107</a> <em>     * @throws FieldGetValueException if there is an internal failure getting the field</em>
<a name="108" href="#108">108</a> <em>     */</em>
<a name="109" href="#109">109</a>     <strong>public</strong> Object getMappedValue(Object obj, String name, String key);
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>     <em>/**<em>*</em></em>
<a name="112" href="#112">112</a> <em>     * Set a value on a field of an object, the types must match and the name must be identical</em>
<a name="113" href="#113">113</a> <em>     * &lt;br/></em>
<a name="114" href="#114">114</a> <em>     * &lt;b>WARNING: Cannot handle a nested/mapped/indexed name&lt;/b></em>
<a name="115" href="#115">115</a> <em>     * @throws FieldnameNotFoundException if this field name is invalid for this object</em>
<a name="116" href="#116">116</a> <em>     * @throws IllegalArgumentException if there is failure</em>
<a name="117" href="#117">117</a> <em>     * @throws FieldSetValueException if there is an internal failure setting the field</em>
<a name="118" href="#118">118</a> <em>     */</em>
<a name="119" href="#119">119</a>     <strong>public</strong> <strong>void</strong> setSimpleValue(Object obj, String name, Object value);
<a name="120" href="#120">120</a> 
<a name="121" href="#121">121</a>     <em>/**<em>*</em></em>
<a name="122" href="#122">122</a> <em>     * For getting an indexed value out of an object based on field name,</em>
<a name="123" href="#123">123</a> <em>     * mostly for internal usage, use getFieldValue</em>
<a name="124" href="#124">124</a> <em>     * &lt;br/></em>
<a name="125" href="#125">125</a> <em>     * &lt;b>WARNING: Cannot handle a nested/mapped/indexed name&lt;/b></em>
<a name="126" href="#126">126</a> <em>     * @throws FieldnameNotFoundException if this field name is invalid for this object</em>
<a name="127" href="#127">127</a> <em>     * @throws IllegalArgumentException if there is failure</em>
<a name="128" href="#128">128</a> <em>     * @throws FieldSetValueException if there is an internal failure setting the field</em>
<a name="129" href="#129">129</a> <em>     */</em>
<a name="130" href="#130">130</a>     <strong>public</strong> <strong>void</strong> setIndexedValue(Object obj, String name, <strong>int</strong> index, Object value);
<a name="131" href="#131">131</a> 
<a name="132" href="#132">132</a>     <em>/**<em>*</em></em>
<a name="133" href="#133">133</a> <em>     * For getting a mapped value out of an object based on field name,</em>
<a name="134" href="#134">134</a> <em>     * mostly for internal usage, use getFieldValue</em>
<a name="135" href="#135">135</a> <em>     * &lt;br/></em>
<a name="136" href="#136">136</a> <em>     * &lt;b>WARNING: Cannot handle a nested/mapped/indexed name&lt;/b></em>
<a name="137" href="#137">137</a> <em>     * @throws FieldnameNotFoundException if this field name is invalid for this object</em>
<a name="138" href="#138">138</a> <em>     * @throws IllegalArgumentException if there is failure</em>
<a name="139" href="#139">139</a> <em>     * @throws FieldSetValueException if there is an internal failure setting the field</em>
<a name="140" href="#140">140</a> <em>     */</em>
<a name="141" href="#141">141</a>     <strong>public</strong> <strong>void</strong> setMappedValue(Object obj, String name, String key, Object value);
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

